<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxPayloadSchemaAttr_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxPayloadSchemaAttr_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>NVTX payload schema attributes.  
 <a href="structnvtx_payload_schema_attr__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad7f767a3d434cd4f55e9924573f3544b" id="r_ad7f767a3d434cd4f55e9924573f3544b"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#ad7f767a3d434cd4f55e9924573f3544b">fieldMask</a></td></tr>
<tr class="memdesc:ad7f767a3d434cd4f55e9924573f3544b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask of valid fields in this struct.  <br /></td></tr>
<tr class="separator:ad7f767a3d434cd4f55e9924573f3544b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba69f3fad4cd1b2e5b129019b1695422" id="r_aba69f3fad4cd1b2e5b129019b1695422"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#aba69f3fad4cd1b2e5b129019b1695422">name</a></td></tr>
<tr class="memdesc:aba69f3fad4cd1b2e5b129019b1695422"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the payload schema. (Optional)  <br /></td></tr>
<tr class="separator:aba69f3fad4cd1b2e5b129019b1695422"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10e7a9740ec894f4b153489deda077e4" id="r_a10e7a9740ec894f4b153489deda077e4"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#a10e7a9740ec894f4b153489deda077e4">type</a></td></tr>
<tr class="memdesc:a10e7a9740ec894f4b153489deda077e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload schema type. (Mandatory)<a class="anchor" id="PAYLOAD_TYPE_FIELD"></a>.  <br /></td></tr>
<tr class="separator:a10e7a9740ec894f4b153489deda077e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af82f33d22722ca11731778945bc44ef6" id="r_af82f33d22722ca11731778945bc44ef6"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#af82f33d22722ca11731778945bc44ef6">flags</a></td></tr>
<tr class="memdesc:af82f33d22722ca11731778945bc44ef6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Payload schema flags. (Optional)  <br /></td></tr>
<tr class="separator:af82f33d22722ca11731778945bc44ef6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa128ebfebfbb3333f41d8a1161b6176" id="r_afa128ebfebfbb3333f41d8a1161b6176"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structnvtx_payload_schema_entry__t.html">nvtxPayloadSchemaEntry_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#afa128ebfebfbb3333f41d8a1161b6176">entries</a></td></tr>
<tr class="memdesc:afa128ebfebfbb3333f41d8a1161b6176"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entries of a payload schema. (Mandatory)<a class="anchor" id="ENTRIES_FIELD"></a>.  <br /></td></tr>
<tr class="separator:afa128ebfebfbb3333f41d8a1161b6176"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc8b55620206061decbac5eb2f3a9051" id="r_afc8b55620206061decbac5eb2f3a9051"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#afc8b55620206061decbac5eb2f3a9051">numEntries</a></td></tr>
<tr class="memdesc:afc8b55620206061decbac5eb2f3a9051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of entries in the payload schema. (Mandatory)  <br /></td></tr>
<tr class="separator:afc8b55620206061decbac5eb2f3a9051"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30c5c448071bcc470f99ff3b76c29a47" id="r_a30c5c448071bcc470f99ff3b76c29a47"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#a30c5c448071bcc470f99ff3b76c29a47">payloadStaticSize</a></td></tr>
<tr class="memdesc:a30c5c448071bcc470f99ff3b76c29a47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The binary payload size in bytes for static payload schemas.  <br /></td></tr>
<tr class="separator:a30c5c448071bcc470f99ff3b76c29a47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7098a38ce30d775c9ce245108ff64db" id="r_ab7098a38ce30d775c9ce245108ff64db"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#ab7098a38ce30d775c9ce245108ff64db">packAlign</a></td></tr>
<tr class="memdesc:ab7098a38ce30d775c9ce245108ff64db"><td class="mdescLeft">&#160;</td><td class="mdescRight">The byte alignment for packed structures.  <br /></td></tr>
<tr class="separator:ab7098a38ce30d775c9ce245108ff64db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1fb939b70bec88c7702d6688ae657fc" id="r_ae1fb939b70bec88c7702d6688ae657fc"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#ae1fb939b70bec88c7702d6688ae657fc">schemaId</a></td></tr>
<tr class="separator:ae1fb939b70bec88c7702d6688ae657fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addb892502797acf269dc928e8614f97f" id="r_addb892502797acf269dc928e8614f97f"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_schema_attr__t.html#addb892502797acf269dc928e8614f97f">extension</a></td></tr>
<tr class="separator:addb892502797acf269dc928e8614f97f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>NVTX payload schema attributes. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00758">758</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="afa128ebfebfbb3333f41d8a1161b6176" name="afa128ebfebfbb3333f41d8a1161b6176"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa128ebfebfbb3333f41d8a1161b6176">&#9670;&#160;</a></span>entries</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structnvtx_payload_schema_entry__t.html">nvtxPayloadSchemaEntry_t</a>* nvtxPayloadSchemaAttr_t::entries</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Entries of a payload schema. (Mandatory)<a class="anchor" id="ENTRIES_FIELD"></a>. </p>
<p>This field is a pointer to an array of schema entries, each describing a field in a data structure, e.g. in a C struct or union. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00793">793</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="addb892502797acf269dc928e8614f97f" name="addb892502797acf269dc928e8614f97f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addb892502797acf269dc928e8614f97f">&#9670;&#160;</a></span>extension</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* nvtxPayloadSchemaAttr_t::extension</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Flexible extension for schema attributes. (Do not use. Reserved for future use.) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00832">832</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ad7f767a3d434cd4f55e9924573f3544b" name="ad7f767a3d434cd4f55e9924573f3544b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7f767a3d434cd4f55e9924573f3544b">&#9670;&#160;</a></span>fieldMask</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadSchemaAttr_t::fieldMask</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mask of valid fields in this struct. </p>
<p>Use the <code>NVTX_PAYLOAD_SCHEMA_ATTR_FIELD_*</code> defines. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00765">765</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="af82f33d22722ca11731778945bc44ef6" name="af82f33d22722ca11731778945bc44ef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af82f33d22722ca11731778945bc44ef6">&#9670;&#160;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadSchemaAttr_t::flags</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload schema flags. (Optional) </p>
<p>Flags defined by <code>NVTX_PAYLOAD_SCHEMA_FLAG_*</code> can be used to set additional properties of the schema. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00785">785</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="aba69f3fad4cd1b2e5b129019b1695422" name="aba69f3fad4cd1b2e5b129019b1695422"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba69f3fad4cd1b2e5b129019b1695422">&#9670;&#160;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* nvtxPayloadSchemaAttr_t::name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Name of the payload schema. (Optional) </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00770">770</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="afc8b55620206061decbac5eb2f3a9051" name="afc8b55620206061decbac5eb2f3a9051"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc8b55620206061decbac5eb2f3a9051">&#9670;&#160;</a></span>numEntries</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadSchemaAttr_t::numEntries</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of entries in the payload schema. (Mandatory) </p>
<p>Number of entries in the array of payload entries <a class="el" href="structnvtx_payload_schema_attr__t.html#ENTRIES_FIELD">ENTRIES_FIELD</a>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00800">800</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ab7098a38ce30d775c9ce245108ff64db" name="ab7098a38ce30d775c9ce245108ff64db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7098a38ce30d775c9ce245108ff64db">&#9670;&#160;</a></span>packAlign</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadSchemaAttr_t::packAlign</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The byte alignment for packed structures. </p>
<p>If not specified, this field defaults to <code>0</code>, which means that the fields in the data structure are not packed and natural alignment rules can be applied. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00819">819</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a30c5c448071bcc470f99ff3b76c29a47" name="a30c5c448071bcc470f99ff3b76c29a47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30c5c448071bcc470f99ff3b76c29a47">&#9670;&#160;</a></span>payloadStaticSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadSchemaAttr_t::payloadStaticSize</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The binary payload size in bytes for static payload schemas. </p>
<p>If <a class="el" href="structnvtx_payload_schema_attr__t.html#PAYLOAD_TYPE_FIELD">PAYLOAD_TYPE_FIELD</a> is NVTX_PAYLOAD_SCHEMA_TYPE_DYNAMIC this value is ignored. If this field is not specified for a schema of type NVTX_PAYLOAD_SCHEMA_TYPE_STATIC, the size can be automatically determined by a tool. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00810">810</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ae1fb939b70bec88c7702d6688ae657fc" name="ae1fb939b70bec88c7702d6688ae657fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1fb939b70bec88c7702d6688ae657fc">&#9670;&#160;</a></span>schemaId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadSchemaAttr_t::schemaId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A static payload schema ID must be unique within the domain, &gt;= NVTX_PAYLOAD_SCHEMA_ID_STATIC_START and &lt; NVTX_PAYLOAD_SCHEMA_ID_DYNAMIC_START </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00826">826</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="a10e7a9740ec894f4b153489deda077e4" name="a10e7a9740ec894f4b153489deda077e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10e7a9740ec894f4b153489deda077e4">&#9670;&#160;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadSchemaAttr_t::type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Payload schema type. (Mandatory)<a class="anchor" id="PAYLOAD_TYPE_FIELD"></a>. </p>
<p>Use the <code>NVTX_PAYLOAD_SCHEMA_TYPE_*</code> defines. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00777">777</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
